<?php

/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Filter
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: StringToUpper.php 16217 2009-06-21 19:39:00Z thomas $
 */


/**
 * @see Zend_Filter_Interface
 */
require_once 'Zend/Filter/Interface.php';


/**
 * @category   Zend
 * @package    Zend_Filter
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Filter_StringToUpper implements Zend_Filter_Interface
{
	/**
	 * Encoding for the input string
	 *
	 * @var string
	 */
	protected $_encoding = null;

	/**
	 * Set the input encoding for the given string
	 *
	 * @param  string $encoding
	 * @throws Zend_Filter_Exception
	 */
	public function setEncoding($encoding = null)
	{
		if (!function_exists('mb_strtoupper')) {
			require_once 'Zend/Filter/Exception.php';
			throw new Zend_Filter_Exception('mbstring is required for this feature');
		}
		$this->_encoding = $encoding;
	}

	/**
	 * Defined by Zend_Filter_Interface
	 *
	 * Returns the string $value, converting characters to uppercase as necessary
	 *
	 * @param  string $value
	 * @return string
	 */
	public function filter($value)
	{
		if ($this->_encoding) {
			return mb_strtoupper((string) $value, $this->_encoding);
		}

		return strtoupper((string) $value);
	}
}
